Skip to content

DOC-4942 ioredis migration docs #1260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 8 commits into from
Apr 15, 2025
Merged

DOC-4942 ioredis migration docs #1260

merged 8 commits into from
Apr 15, 2025
+455 −4

Conversation

@andy-stark-redis
Copy link
Contributor

@andy-stark-redis andy-stark-redis commented Mar 6, 2025 •
edited by atlassian bot
Loading

DOC-4942

Currently a work in progress - all suggestions welcome :-)

In particular:

  • Is "migration" the right word to use here?
  • Is the basic format OK with the summary table and expanded explanations?
  • Are the existing items important enough to mention?
  • Which other items should we have on this page?
  • Do we want an explicit migration instruction emphasised for each step? (For example, just under the Pipelining section heading, we could say "To migrate: search for instances of pipeline() and replace them with multi()...execAsPipeline()).

@andy-stark-redis andy-stark-redis self-assigned this Mar 6, 2025
@andy-stark-redis andy-stark-redis requested a review from a team March 6, 2025 10:38
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2025 •
edited
Loading

Staging links:
https://redis.io/docs/staging/DOC-4942-ioredis-migration-docs/develop/clients/nodejs/connect
https://redis.io/docs/staging/DOC-4942-ioredis-migration-docs/develop/clients/nodejs/migration
https://redis.io/docs/staging/DOC-4942-ioredis-migration-docs/develop/clients/nodejs/transpipe

dwdougherty
dwdougherty approved these changes Mar 6, 2025
View reviewed changes
Copy link
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few things to consider, but thus far, looks good to me.

content/develop/clients/nodejs/migration.md
`node-redis` supports only `Promise` objects for results, so
you must always use a `then()` handler or the
[`await`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
operator to receive them.
Copy link
Collaborator

@dwdougherty dwdougherty Mar 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just wondering if await should be used for examples that return promises. Not a JavaScript guy (but I play one at work), so just thinking out loud.

@andy-stark-redis andy-stark-redis merged commit 71a2ec2 into main Apr 15, 2025
5 checks passed
@andy-stark-redis andy-stark-redis deleted the DOC-4942-ioredis-migration-docs branch April 15, 2025 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dwdougherty dwdougherty dwdougherty approved these changes

@mortensi mortensi Awaiting requested review from mortensi

@dmaier-redislabs dmaier-redislabs Awaiting requested review from dmaier-redislabs

Assignees

@andy-stark-redis andy-stark-redis

Labels

do not merge yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@andy-stark-redis @dwdougherty